home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / tma114.zip / MODERATE.DOC < prev    next >
Text File  |  1992-09-10  |  11KB  |  292 lines
  1.                        The Moderator's Assistant
  2.                           A Waffle BBS utility
  3.                   Copyright 1992 by Roy M. Silvernail
  4.  
  5. --------------------------------------------------------------------------
  6. The Moderator's Assistant is a shareware program.  You may evaluate it
  7. free of charge for a reasonable period, after which you must register
  8. it.  See the Registration section at the end of this document for
  9. registration details.
  10. --------------------------------------------------------------------------
  11.  
  12.  
  13.                    What is The Moderator's Assistant?
  14.  
  15. Waffle administrators are familiar with moderated newsgroups, where
  16. posts are sent to a central processing point for consideration, rather
  17. than being posted directly to the newsgroup.  Waffle has the means to
  18. direct posts for moderated groups to the moderator's mail address, but
  19. no direct support for hosting a moderated group.
  20.  
  21. The hooks are there, however, and The Moderator's Assistant hangs on
  22. them.  TMA gives you the ability to process mail messages into approved
  23. news messages easily, using your favorite external editor and standard
  24. Waffle support programs.
  25.  
  26.  
  27.  
  28.                 How do I use The Moderator's Assistant?
  29.  
  30. It's easy!  Simply install MODERATE.EXE in /waffle/bin, add a command to
  31. /waffle/extern, and place a few configuration lines in
  32. /waffle/system/static.  Then set up your addresses to receive traffic
  33. for your moderated group or groups.  TMA reads the static file to get
  34. information it needs about your Waffle system.
  35.  
  36.  
  37.  
  38.                       Installation, step by step:
  39.  
  40. 1.  Copy MODERATE.EXE into your bin directory (usually /waffle/bin).
  41.  
  42. 2.  Create an external command called 'moderate', using this form for
  43.     the /waffle/extern/moderate file:
  44.  
  45.     /access=9 /screen /command="c:\waffle\bin\moderate %i"
  46.  
  47.     The /screen switch isn't needed if your favorite external editor
  48.     doesn't need it.  Set the /access level lower if you plan to have
  49.     people other than the sysadmin controlling moderated groups.
  50.  
  51. 3.  Add these lines to your static file:
  52.  
  53. # a _full pathname_ to your external editor, with %s where the filename
  54. # goes.  This allows you to use any editor, even if it needs multiple
  55. #  switches or switches after the filename.
  56.  
  57. mod.edit    : c:/tools/q.exe %s
  58.  
  59. # the name to appear in the Approved: line  (Approved: news@mysite)
  60.  
  61. mod.approve : news
  62.  
  63.     The colon is _not optional_.  If you do not include it in these
  64.     lines, TMA will not be able to read your static file entries
  65.     correctly.
  66.  
  67.     TMA must use an external editor.  It _will not_ work with the
  68.     internal Waffle editor.  For console use, Qedit works well.
  69.     Remotely, consider BBStevie or FSED.
  70.  
  71.     The mod.approve name may be any legal username, but usually is left
  72.     as 'news'.  It will default to 'news' if there is no entry for
  73.     mod.approve.
  74.  
  75. 4.  Create a file in /waffle/system called moderate.dat.  In this file,
  76.     place the moderated group definition lines, in the form
  77.  
  78.     group.name  username
  79.  
  80.     where 'username' is a username on your system to which submissions
  81.     are mailed.  As an example, suppose you have mod.foo posts coming to
  82.     the 'carson' mailbox.  You enter
  83.  
  84.     mod.foo   carson
  85.  
  86.     in moderate.dat.  Group names may be separated from mailbox names by
  87.     spaces or tabs.
  88.  
  89.     If you are running version 1.65 of Waffle, you can collect all
  90.     moderated groups under a single username, but in different folders.
  91.     The form is
  92.  
  93.     group.name  username    folder
  94.  
  95.     To divert mail to a particular folder, you need to create an entry
  96.     in /waffle/system/aliases of this type:
  97.  
  98.     group-mail-address = c:/user/username/folder
  99.  
  100.     (note the = sign)  The group-mail-address is simply the username on
  101.     your system to which posts for this group are sent.  Remember to use
  102.     different names for each folder, and don't put an extension on the
  103.     folder name.
  104.  
  105.     Folder names are optional.  If left out, that group will default to
  106.     "mailbox".  Under 1.64 and below, folder names will be ignored.
  107.  
  108.  
  109. 5.  Create the newsgroup (or groups) that you will moderate.  Setup is
  110.     exactly like any other moderated group.  The /mod address should be
  111.     the username on your system that will receive the posts.  Tell your
  112.     news neighbors that the group is ready to receive traffic, and where
  113.     to send posts.
  114.  
  115. 6.  Sit back and wait for some traffic to arrive!
  116.  
  117.  
  118.  
  119.                     Using The Moderator's Assistant:
  120.  
  121. Login to your Waffle system, and type 'moderate news.group', where
  122. news.group is the name of the group you are moderating.  TMA looks
  123. almost exactly like the Waffle mail interface, and you have many of the
  124. same commands.
  125.  
  126. The Moderator's Assistant commands are mostly self-explanatory:
  127.  
  128. AGAIN       - Reread message
  129. BACK        - Go back one message
  130. DELETE      - Mark current message for deletion
  131. EDIT        - Edit the current message
  132.         (you can edit the entire message, but it's recommended not to
  133.          mess with the headers)
  134. HELP        - Display this menu
  135. LIST        - List the messages available
  136. NEXT        - Read next message
  137. QUIT        - Exit The Moderator's Assistant
  138. POST        - Post the current message
  139.             (with an argument, post to the given group.  any group is ok)
  140.  
  141. Version 1.65 users have full folder support, as well:
  142.  
  143. LIST        - List the messages available in the current folder
  144. GO          - Go to a different folder (1.65 only)
  145. MOVE        - Move the current message to a new folder
  146.  
  147. That's all there is to it!
  148.  
  149.  
  150.  
  151.                                Problems?
  152.  
  153.     TMA tells me there's no mail waiting for my moderated group, but I
  154.     know there is.
  155.  
  156. Check the mod.group line for that group in your static file to make sure
  157. that it has the correct username for that groupname.  Be sure that the
  158. static file entries are separated by colons.
  159.  
  160.  
  161.     I see an error message about "No valid newsgroups" when I post a
  162.     message with TMA.
  163.  
  164. You don't have the group created in your forum description file.  The
  165. group must be entered in /waffle/system/usenet (or a similar file, if
  166. you have your locally moderated groups separated) so RNEWS can find it.
  167. If you elected to post to a different group that you are moderating, you
  168. may not carry it.  Look in junk for your article, and check that it's
  169. been queued for your newsfeed site.  (it probably has been)
  170.  
  171.  
  172.     Help!  TMA locks up my system when I try to post or edit a
  173.     submission!
  174.  
  175. You probably have a memory problem.  TMA uses as little memory as
  176. possible, but it still has to use some for itself and some more for
  177. spawning your editor and RNEWS.  Use the 'mem' command to see how much
  178. memory is available from within Waffle.  You'll need about 200K free to
  179. use TMA sucessfully from Waffle.  You can get more memory available by
  180. reducing the buflines and maxquote settings in the static file.  You'll
  181. probably never be able to moderate a group with 100K+ posts from inside
  182. Waffle, though.
  183.  
  184. If you still have problems (perhaps because of a large number of
  185. newsgroups in the usenet file), you will probably have to run TMA from
  186. the command line.  The procedure is exactly the same as from within
  187. Waffle.
  188.  
  189.  
  190.     Nothing works!  All I get is "TMA system error something"!
  191.  
  192. First, run TMA with debug enabled.  Use 'moderate -d group.name', and
  193. observe the output.  TMA will show you what it found in your static
  194. file, and check some other crucial details.  If that points up a
  195. problem, you can probably fix it yourself.
  196.  
  197. If you still have problems, or you're still getting system error
  198. messages, please mail a screen-dump and details of your problem to the
  199. author for a bug fix.  (if you are the first to report a particular bug,
  200. you'll earn a free registration)
  201.  
  202.  
  203.  
  204.                                 Support:
  205.  
  206. The author, Roy M. Silvernail, can be contacted by E-mail at
  207.  
  208. Internet:   roy%cybrspc@cs.umn.edu  (a Waffle beta test site)
  209. WWIVnet:    1@503 (a WWCP beta test site)
  210.  
  211. or by surface mail
  212.  
  213. Roy M. Silvernail
  214. 3120 Pillsbury, #309
  215. Minneapolis, MN  55408
  216.  
  217.  
  218.                            Acknowledgements:
  219.  
  220. The Moderator's Assistant owes much to Stan Hall
  221. (kilgore@wuntvor.norman.ok.us) for being the fearless beta team.  His
  222. suggestions proved extremely helpful
  223.  
  224.  
  225.  
  226.                              Registration:
  227.  
  228. The Moderator's Assistant is not free software.  TMA is copyright 1992
  229. by Roy M. Silvernail, and is offered for you to evaluate without charge
  230. in a non-commercial setting.  If you continue to use The Moderator's
  231. Assistant beyond a reasonable evaluation period, you must purchase a
  232. license and register this program.  60 days seems reasonable for
  233. evaluation purposes.  The offer of free evaluation does not extend to
  234. commercial, business or government entities.  If you are considering TMA
  235. for commercial use, please evaluate it outside of the commercial
  236. application.
  237.  
  238. Registering TMA will remove the shareware message header in posted
  239. messages.  TMA is not crippled in any way.
  240.  
  241. A license for The Moderator's Assistant costs $10 US, $13 CAN.  Outside
  242. North America, please remit in US funds.  This is a book-like license,
  243. allowing you to use your copy of TMA on one CPU at a time.  Users of
  244. multitasking software may run unlimited copies of TMA on a single CPU.
  245. Site licenses are available... please contact the author for details.
  246.  
  247. By registering The Moderator's Assistant, you help ensure the success of
  248. the shareware concept, as well as continued development and inovation in
  249. Waffle support.
  250.  
  251.  
  252. -------------------------------------------------------------------------
  253.  
  254.  
  255.                   The Moderator's Assistant Order Form
  256.  
  257. Please send the completed form, along with check or money order for
  258. $10.00 US, $13.00 CAN to:
  259.  
  260. Roy M. Silvernail
  261. 3130 Pillsbury, #309
  262. Minneapolis, MN  55408
  263.  
  264.  
  265. Your name:    __________________________________________________________
  266.  
  267. Organization: __________________________________________________________
  268.  
  269. Street:       __________________________________________________________
  270.  
  271. City:         __________________________________________________________
  272.  
  273. State:        __________________________________________________________
  274.  
  275. Zip:          __________________________________________________________
  276.  
  277. Telephone:    __________________________________________________________
  278.  
  279. Internet address: ______________________________________________________
  280.  
  281. Where did you get your copy of TMA?_____________________________________
  282.  
  283. Please add any comments or ideas you have to share:_____________________
  284.  
  285. ________________________________________________________________________
  286.  
  287. ________________________________________________________________________
  288.  
  289.  
  290. Thank you for registering The Moderator's Assistant!
  291.  
  292.